Search Recipient Income
Retrieves assertions about the patient's annual income in different years. In some cases, there may be more than one assertion within a given year. Can also return
Mechanism
GET [base]/Observation?code=https%3A//bpcs.exchange/fhir/CodeSystem/cs-ObservationTypes%7Cincome& followed by either patient=[ODBNumber] or _in=Group/[ApplicationNumber]
The first will find the incomes for a single individual. The second will find the income for all individuals associated with a family coverage application. (Note that some users may be restricted to only one type of search or the other.
Payload | Example |
---|---|
In: No payload. | |
Out: HTTP 200 with Observation Income Bundle, which will be empty if the recipient was not found | Observation Income Search Example |